org.eclipse.vtp.framework.engine.support
Class AbstractReporter

java.lang.Object
  extended by org.eclipse.vtp.framework.engine.support.AbstractReporter
All Implemented Interfaces:
IReporter
Direct Known Subclasses:
AbstractLogger, Activator

public abstract class AbstractReporter
extends java.lang.Object
implements IReporter

A support implementation of the IReporter interface.

Author:
Lonnie Pryor

Field Summary
 
Fields inherited from interface org.eclipse.vtp.framework.core.IReporter
SEVERITY_DEBUG, SEVERITY_ERROR, SEVERITY_INFO, SEVERITY_WARN
 
Constructor Summary
protected AbstractReporter()
          Creates a new AbstractReporter.
 
Method Summary
protected abstract  void doReport(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Implementation of report creation and publication after checking the severity.
 void report(int severity, java.lang.String message)
          Creates and publishes a reporting entry with the specified attributes.
 void report(int severity, java.lang.String[] categories, java.lang.String message)
          Creates and publishes a reporting entry with the specified attributes.
 void report(int severity, java.lang.String[] categories, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a reporting entry with the specified attributes.
 void report(int severity, java.lang.String message, java.util.Dictionary properties)
          Creates and publishes a reporting entry with the specified attributes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.vtp.framework.core.IReporter
isSeverityEnabled
 

Constructor Detail

AbstractReporter

protected AbstractReporter()
Creates a new AbstractReporter.

Method Detail

doReport

protected abstract void doReport(int severity,
                                 java.lang.String[] categories,
                                 java.lang.String message,
                                 java.util.Dictionary properties)
Implementation of report creation and publication after checking the severity.

Parameters:
severity - The severity of the report.
categories - The categories the report pertains to or null if no catagories are related.
message - The message associated with the report or null to not include a message.
properties - The properties of the report or null if no properties are specified.

report

public final void report(int severity,
                         java.lang.String message)
Description copied from interface: IReporter
Creates and publishes a reporting entry with the specified attributes.

Specified by:
report in interface IReporter
Parameters:
severity - The severity of the report.
message - The message associated with the report or null to not include a message.

report

public final void report(int severity,
                         java.lang.String message,
                         java.util.Dictionary properties)
Description copied from interface: IReporter
Creates and publishes a reporting entry with the specified attributes.

Specified by:
report in interface IReporter
Parameters:
severity - The severity of the report.
message - The message associated with the report or null to not include a message.
properties - The properties of the report or null if no properties are specified.

report

public final void report(int severity,
                         java.lang.String[] categories,
                         java.lang.String message)
Description copied from interface: IReporter
Creates and publishes a reporting entry with the specified attributes.

Specified by:
report in interface IReporter
Parameters:
severity - The severity of the report.
categories - The categories the report pertains to or null if no catagories are related.
message - The message associated with the report or null to not include a message.

report

public final void report(int severity,
                         java.lang.String[] categories,
                         java.lang.String message,
                         java.util.Dictionary properties)
Description copied from interface: IReporter
Creates and publishes a reporting entry with the specified attributes.

Specified by:
report in interface IReporter
Parameters:
severity - The severity of the report.
categories - The categories the report pertains to or null if no catagories are related.
message - The message associated with the report or null to not include a message.
properties - The properties of the report or null if no properties are specified.